feat(MultiSelect): redesign IsFixedSearch function #5651

ArgoZhang · 2025-03-18T03:55:34Z

Link issues

Summary By Copilot

This pull request includes significant updates to the MultiSelect and Select components, focusing on enhancing the search functionality and refactoring related code. Key changes include the addition of new parameters, updates to the rendering logic, and adjustments to the unit tests to reflect these updates.

Enhancements to Search Functionality:

src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor: Added new search-related UI elements and updated the layout to include toggles for ShowSearch and IsFixedSearch.
src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs: Introduced new boolean fields _isFixedSearch and _showSearch to manage the search behavior.

Updates to MultiSelect Component:

src/BootstrapBlazor/Components/Select/MultiSelect.razor: Modified the rendering logic to conditionally display search elements and handle empty search results. [1] [2]
src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs: Removed the SearchClassString property and updated the DropdownMenuClassString property to include search-related classes.

Updates to Select Component:

src/BootstrapBlazor/Components/Select/Select.razor: Adjusted the search input rendering and added handling for empty search results.
src/BootstrapBlazor/Components/Select/Select.razor.cs: Removed the IsFixedSearch parameter and updated the DropdownMenuClassString property to reflect the new search logic. [1] [2] [3]

Refactoring and Code Cleanup:

src/BootstrapBlazor/Components/Select/SelectBase.cs: Added the IsFixedSearch parameter and updated the DropdownMenuClassString property to handle fixed search scenarios. [1] [2]
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor: Updated the search input rendering and empty search result handling. [1] [2] [3]
src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs: Removed the IsFixedSearch parameter and updated related methods to use new search logic. [1] [2] [3] [4] [5] [6]

Unit Test Adjustments:

test/UnitTest/Components/MultiSelectTest.cs: Added tests to verify the toolbar visibility based on the presence of data.
test/UnitTest/Components/SelectGenericTest.cs: Updated tests to reflect changes in the search-related class names.

Regression?

Yes
No

Risk

High
Medium
Low

Verification

Manual (required)
Automated

Packaging changes reviewed?

Yes
No
N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

Doc is updated/provided or not needed
Demo is updated/provided or not needed
Merge the latest code from the main branch

Summary by Sourcery

Refactors the search functionality in the MultiSelect and Select components to improve usability and code maintainability. The changes include UI enhancements, code cleanup, and updates to unit tests.

Enhancements:

Refactors the search functionality in the MultiSelect and Select components.
Updates the rendering logic for search input and empty search results in MultiSelect and Select components.
Removes the SearchClassString property from MultiSelect and SelectGeneric components.
Updates the DropdownMenuClassString property to include search-related classes in MultiSelect, Select, and SelectBase components.
Adds the IsFixedSearch parameter to SelectBase component.
Removes the IsFixedSearch parameter from Select and SelectGeneric components.
Updates related methods to use new search logic in SelectGeneric component.
Updates tests to reflect changes in the search-related class names in SelectGenericTest component.
Adds new search-related UI elements and updates the layout to include toggles for ShowSearch and IsFixedSearch in MultiSelects sample component.
Introduces new boolean fields _isFixedSearch and _showSearch to manage the search behavior in MultiSelects sample component.
Moves the toolbar rendering logic inside the dropdown-menu-body div in MultiSelect component.
Adds a check for Rows.Count before rendering the dropdown-menu-body in MultiSelect component.
Removes the SearchClassString property and updates the DropdownMenuClassString property to include search-related classes in MultiSelect component.
Updates the search input rendering and empty search result handling in SelectGeneric component.
Removes the IsFixedSearch parameter and updates related methods to use new search logic in SelectGeneric component.
Updates the search input rendering in Select component.
Removes the IsFixedSearch parameter and updates the DropdownMenuClassString property to reflect the new search logic in Select component.
Adds the IsFixedSearch parameter and updates the DropdownMenuClassString property to handle fixed search scenarios in SelectBase component.
Updates the toolbar visibility test in MultiSelectTest component to check for toolbar visibility based on the presence of data.
Removes the SearchClassString property from MultiSelect component.
Updates the DropdownMenuClassString property to include search-related classes in MultiSelect component.
Updates the search input rendering in Select component.
Removes the IsFixedSearch parameter from Select component.
Updates the DropdownMenuClassString property to reflect the new search logic in Select component.
Adds the IsFixedSearch parameter to SelectBase component.
Updates the DropdownMenuClassString property to handle fixed search scenarios in SelectBase component.
Updates the toolbar visibility test in MultiSelectTest component to check for toolbar visibility based on the presence of data.
Removes the SearchClassString property from MultiSelect component.
Updates the DropdownMenuClassString property to include search-related classes in MultiSelect component.
Updates the search input rendering in Select component.
Removes the IsFixedSearch parameter from Select component.
Updates the DropdownMenuClassString property to reflect the new search logic in Select component.
Adds the IsFixedSearch parameter to SelectBase component.
Updates the DropdownMenuClassString property to handle fixed search scenarios in SelectBase component.
Updates the toolbar visibility test in MultiSelectTest component to check for toolbar visibility based on the presence of data.

sourcery-ai · 2025-03-18T03:55:39Z

Reviewer's Guide by Sourcery

This pull request redesigns the IsFixedSearch function across multiple components (MultiSelect, Select, SelectGeneric) by introducing a new IsFixedSearch parameter in SelectBase, refactoring search-related properties, and updating rendering logic to handle the fixed search bar. Additionally, the pull request includes updates to the sample component and unit tests to reflect these changes.

Updated class diagram for SelectBase

classDiagram
  class SelectBase {
    +bool ShowSearch
    +bool IsFixedSearch
    +string SearchIcon
    +string NoDataTip
    +string NoSearchDataText
    +string DropdownMenuClassString
  }

Updated class diagram for Select

classDiagram
  class Select {
    -string DropdownMenuClassString
  }

File-Level Changes

Change	Details	Files
Introduced `IsFixedSearch` parameter to `SelectBase` to control the search bar's fixed position within the dropdown.	Added `IsFixedSearch` parameter to `SelectBase`. Updated `DropdownMenuClassString` property in `SelectBase` to include `is-fixed-search` class when `ShowSearch` and `IsFixedSearch` are true.	`src/BootstrapBlazor/Components/Select/SelectBase.cs`
Refactored search-related properties and rendering logic in `MultiSelect` component.	Modified rendering logic to conditionally display search elements and handle empty search results. Removed the `SearchClassString` property. Updated the `DropdownMenuClassString` property to include search-related classes.	`src/BootstrapBlazor/Components/Select/MultiSelect.razor` `src/BootstrapBlazor/Components/Select/MultiSelect.razor.cs`
Updated search input rendering and handling of empty search results in `Select` and `SelectGeneric` components.	Adjusted the search input rendering. Added handling for empty search results. Removed the `IsFixedSearch` parameter.	`src/BootstrapBlazor/Components/Select/Select.razor` `src/BootstrapBlazor/Components/Select/Select.razor.cs` `src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor` `src/BootstrapBlazor/Components/SelectGeneric/SelectGeneric.razor.cs`
Added UI elements and logic to control `ShowSearch` and `IsFixedSearch` in the `MultiSelects` sample component.	Added new search-related UI elements. Updated the layout to include toggles for `ShowSearch` and `IsFixedSearch`. Introduced new boolean fields `_isFixedSearch` and `_showSearch` to manage the search behavior.	`src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor` `src/BootstrapBlazor.Server/Components/Samples/MultiSelects.razor.cs`
Adjusted unit tests to accommodate changes in search-related class names and toolbar visibility.	Added tests to verify the toolbar visibility based on the presence of data. Updated tests to reflect changes in the search-related class names.	`test/UnitTest/Components/MultiSelectTest.cs` `test/UnitTest/Components/SelectGenericTest.cs`

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#5650	Redesign the IsFixedSearch function in the MultiSelect component to be consistent with the Select component.	✅

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @ArgoZhang - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding a sample to showcase the new IsFixedSearch functionality.
The commit history could be improved by squashing the commits into a single commit with a descriptive message.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

codecov · 2025-03-18T03:59:39Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3a7ffe4) to head (8955040).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #5651   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          653       653           
  Lines        29393     29387    -6     
  Branches      4195      4197    +2     
=========================================
- Hits         29393     29387    -6

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

ArgoZhang added 8 commits March 18, 2025 11:41

refactor: IsFixedSearch 移动到基类

58af2d4

doc: 代码规范化

ae59f14

fix: 重构固定搜索栏功能

60fba29

doc: 更新示例

154dca4

test: 更新单元测试

ff5b881

refactor: 移动 DropdownMenuClassString 到基类

1200ca4

refactor: 改造 SelectGeneric 组件适配 IsFixedSearch 功能

03fc9e1

test: 更新单元测试

f4deacc

bb-auto bot assigned ArgoZhang Mar 18, 2025

bb-auto bot added the enhancement New feature or request label Mar 18, 2025

bb-auto bot added this to the v9.4.0 milestone Mar 18, 2025

sourcery-ai bot previously approved these changes Mar 18, 2025

View reviewed changes

ArgoZhang added 2 commits March 18, 2025 12:15

refactor: 精简代码

fad62f9

doc: 更新示例

8955040

ArgoZhang dismissed sourcery-ai[bot]’s stale review via 8955040 March 18, 2025 04:16

ArgoZhang merged commit 9f1df2b into main Mar 18, 2025
3 checks passed

ArgoZhang deleted the feat-multi-select branch March 18, 2025 04:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat(MultiSelect): redesign IsFixedSearch function #5651

feat(MultiSelect): redesign IsFixedSearch function #5651

Uh oh!

ArgoZhang commented Mar 18, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Mar 18, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Uh oh!

codecov bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat(MultiSelect): redesign IsFixedSearch function #5651

feat(MultiSelect): redesign IsFixedSearch function #5651

Uh oh!

Conversation

ArgoZhang commented Mar 18, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Link issues

Summary By Copilot

Enhancements to Search Functionality:

Updates to MultiSelect Component:

Updates to Select Component:

Refactoring and Code Cleanup:

Unit Test Adjustments:

Regression?

Risk

Verification

Packaging changes reviewed?

☑️ Self Check before Merge

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Updated class diagram for SelectBase

Updated class diagram for Select

File-Level Changes

Assessment against linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ArgoZhang commented Mar 18, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Mar 18, 2025 •

edited

Loading

codecov bot commented Mar 18, 2025 •

edited

Loading